<html>
   <head>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="">
<h2 class="comptitle">Simple Module <i>BaseWorldUtility</i></h2>
<b>Package:</b> org.mixim.base.modules<br/><b>File: <a href="base-modules-BaseWorldUtility.ned.html">base/modules/BaseWorldUtility.ned</a></b><br/><p><a href="../doxy/a00031.html" target="mainframe"><b>C++ definition</b></a></p>

<p>Basic utility module for the whole network.
Provides utility methods and information used by
the whole network as well as simulation wide
black board functionality.</p>
<img src="org.mixim.base.modules.BaseWorldUtility-type.png" ismap="yes" usemap="#type-diagram"/><map name="type-diagram">
<area shape="rect" href="org.mixim.base.modules.BaseWorldUtility.html" title="BaseWorldUtility" alt="BaseWorldUtility" coords="0,0,151,38">
</map>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram. Click <a href="full-ned-usage-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.base.modules.BaseWorldUtility-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" id="node1" href="org.mixim.base.modules.BaseWorldUtility.html" title="Simple Module BaseWorldUtility" alt="" coords="577,83,697,111">
<area shape="rect" id="node2" href="org.mixim.examples.analogueModels.AnalogueModels.html" title="Network AnalogueModels" alt="" coords="5,6,123,34">
<area shape="rect" id="node4" href="org.mixim.examples.BaseMoBANNetwork.BaseMoBANNetwork.html" title="Network BaseMoBANNetwork" alt="" coords="147,6,293,34">
<area shape="rect" id="node6" href="org.mixim.examples.baseNetwork.BaseNetwork.html" title="Network BaseNetwork" alt="" coords="317,6,419,34">
<area shape="rect" id="node8" href="org.mixim.examples.bmac.BMAC.html" title="Network BMAC" alt="" coords="443,6,515,34">
<area shape="rect" id="node10" href="org.mixim.examples.CSMAMac.CSMAMac.html" title="Network CSMAMac" alt="" coords="539,6,624,34">
<area shape="rect" id="node12" href="org.mixim.examples.ieee802154a.ieee802154a.html" title="Network ieee802154a" alt="" coords="648,6,741,34">
<area shape="rect" id="node14" href="org.mixim.examples.lmac.LMAC.html" title="Network LMAC" alt="" coords="765,6,837,34">
<area shape="rect" id="node16" href="org.mixim.examples.Mac80211.Mac80211.html" title="Network Mac80211" alt="" coords="861,6,944,34">
<area shape="rect" id="node18" href="org.mixim.examples.multiConnectionManager.MultiConnectionManager.html" title="Network MultiConnectionManager" alt="" coords="968,6,1133,34">
<area shape="rect" id="node20" href="org.mixim.examples.WSNRouting.WSNRouting.html" title="Network WSNRouting" alt="" coords="1157,6,1256,34">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram. Click <a href="full-ned-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.base.modules.BaseWorldUtility-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" id="node1" href="org.mixim.base.modules.BaseWorldUtility.html" title="Simple Module BaseWorldUtility" alt="" coords="5,83,125,111">
<area shape="rect" id="node4" href="org.mixim.examples.ieee802154Narrow.WorldUtilityStats.html" title="Simple Module WorldUtilityStats" alt="" coords="5,161,125,189">
<area shape="rect" id="node2" href="org.mixim.base.modules.Blackboard.html" title="Simple Module Blackboard" alt="" coords="23,6,108,34">
</map>
<h3 class="subtitle">Extends:</h3>
<table>
<tr>
   <td>
      <a href="org.mixim.base.modules.Blackboard.html">Blackboard</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Provides black board like information
exchange</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Known subclasses:</h3>
<table>
<tr>
   <td>
      <a href="org.mixim.examples.ieee802154Narrow.WorldUtilityStats.html">WorldUtilityStats</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Tracks simulation wide traffic statistics</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Networks:</h3>
<table>
<tr>
   <td>
      <a href="org.mixim.examples.analogueModels.AnalogueModels.html">AnalogueModels</a>
      <i> (network)</i>
   </td>
   <td>

<p>This example shows how to use <a href="org.mixim.examples.analogueModels.AnalogueModels.html">AnalogueModels</a>.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.BaseMoBANNetwork.BaseMoBANNetwork.html">BaseMoBANNetwork</a>
      <i> (network)</i>
   </td>
   <td>

<p>This network is exactly the same as baseNetwork existing among the examples of MiXiM, but the desired number of MoBAN coordinator modules have been added.
Some nodes of type <a href="org.mixim.examples.baseNetwork.BaseNode.html">BaseNode</a> use <a href="org.mixim.modules.mobility.MoBANLocal.html">MoBANLocal</a> module as their mobility module. Then those nodes will be considered as WBAN nodes. 
Those node have a parameter named "coordinatorIndex" that determines to which WBAN (coordinator) the node belongs.  </p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.baseNetwork.BaseNetwork.html">BaseNetwork</a>
      <i> (network)</i>
   </td>
   <td>

<p>This example shows the basic structure of an network using MiXiM.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.bmac.BMAC.html">BMAC</a>
      <i> (network)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.CSMAMac.CSMAMac.html">CSMAMac</a>
      <i> (network)</i>
   </td>
   <td>

<p>This example shows how to use MiXiMs CSMA protocol implementation.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.ieee802154a.ieee802154a.html">ieee802154a</a>
      <i> (network)</i>
   </td>
   <td>

<p>This example illustrates the use of the IEEE 802.15.4A UWB-IR
simulation model implemented in MiXiM.
The omnetpp.ini files comprises two scenarios. Both scenarios
involve only two hosts.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.lmac.LMAC.html">LMAC</a>
      <i> (network)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.Mac80211.Mac80211.html">Mac80211</a>
      <i> (network)</i>
   </td>
   <td>

<p>This example shows how to use MiXiMs 802.11 protocol implementation. </p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.multiConnectionManager.MultiConnectionManager.html">MultiConnectionManager</a>
      <i> (network)</i>
   </td>
   <td>

<p>This example shows how to use multiple ConnectionManagers in your simulation. </p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.WSNRouting.WSNRouting.html">WSNRouting</a>
      <i> (network)</i>
   </td>
   <td>

<p>This example shows how to simulate wireless sensor networks.
Three different routing protocols are considered, for different traffic 
types:
convergecast, with Wiseroute;
network-level broadcast, with flooding;
and probabilistic broadcast.</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Parameters:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Default value</th>
      <th>Description</th>
   </tr>
<tr class="inherited">
   <td width="150">coreDebug</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>debug switch for the base framework</p>
   </td>
</tr>
<tr class="local">
   <td width="150">playgroundSizeX</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>x size of the area the nodes are in (in meters)</p>
   </td>
</tr>
<tr class="local">
   <td width="150">playgroundSizeY</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>y size of the area the nodes are in (in meters)</p>
   </td>
</tr>
<tr class="local">
   <td width="150">playgroundSizeZ</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>z size of the area the nodes are in (in meters)</p>
   </td>
</tr>
<tr class="local">
   <td width="150">useTorus</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>use the playground as torus?</p>
   </td>
</tr>
<tr class="local">
   <td width="150">use2D</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>use a 2-dimensional world?</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Properties:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
   </tr>
<tr>
   <td width="150">class</td>
   <td width="100"><i>BaseWorldUtility</i></td>
   <td></td>
</tr>
<tr>
   <td width="150">display</td>
   <td width="100"><i>i=misc/globe</i></td>
   <td></td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #808080; font-style: italic; ">// Basic utility module for the whole network.
// Provides utility methods and information used by
// the whole network as well as simulation wide
// black board functionality.
</span><span style="color: #800000; font-weight: bold; ">simple</span><span style="color: #000000; "> </span><span style="color: #000000; ">BaseWorldUtility</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">extends</span><span style="color: #000000; "> </span><span style="color: #000000; ">Blackboard</span><span style="color: #000000; ">
{
    </span><span style="color: #800000; font-weight: bold; ">parameters</span><span style="color: #000000; ">:
        </span><span style="color: #000000; font-weight: bold; ">@class</span><span style="color: #000000; ">(</span><span style="color: #000000; ">BaseWorldUtility</span><span style="color: #000000; ">);
        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">playgroundSizeX</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">m</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// x size of the area the nodes are in (in meters)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">playgroundSizeY</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">m</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// y size of the area the nodes are in (in meters)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">playgroundSizeZ</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">m</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// z size of the area the nodes are in (in meters)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">useTorus</span><span style="color: #000000; ">;                  </span><span style="color: #808080; font-style: italic; ">// use the playground as torus?
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">use2D</span><span style="color: #000000; ">;                    </span><span style="color: #808080; font-style: italic; ">// use a 2-dimensional world?
</span><span style="color: #000000; ">        </span><span style="color: #000000; font-weight: bold; ">@display</span><span style="color: #000000; ">(</span><span style="color: #008000; ">&quot;i=misc/globe&quot;</span><span style="color: #000000; ">);
}

</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
